Add top guides section to a11y intro + a11y content updates #6059
Conversation
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
top-guides-a11y
|
| Run status |
|
| Run duration | 03m 23s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
279
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
10.85%
|
|
|---|---|
|
Untested elements
|
2227
|
|
Tested elements
|
3
|
Accessibility
95.71%
|
|
|---|---|
|
Failed rules
|
2 critical
5 serious
4 moderate
0 minor
|
|
Failed elements
|
501
|
jennifer-shehane
changed the title
There was a problem hiding this comment.
Pointed out a few things here and there. Overall this is a big improvement in readability and scanning, I'm surprised how much actually, the before and after is really a different experience. Marking "request changes" specifically as there is chunk in the "About Axe Core®" section that cuts off unexpectedly.
|
|
||
| The most important thing about the score is that it is deterministic and consistent across runs, so that when changes in the application do bubble up to show an increase or decrease in the score, that is going be meaningful, and not noise. | ||
| The key value of the score is its consistency across runs. Changes in the score reliably reflect accessibility improvements or regressions. |
There was a problem hiding this comment.
I think this change doesn't end up more readable, I'm suggesting a longer variant that might be clearer.
| The key value of the score is its consistency across runs. Changes in the score reliably reflect accessibility improvements or regressions. | |
| The key value of the score that the calculation is repeated consistently across runs - Cypress is not trying to catch anything "in the moment" during test execution. This means that changes in the score reliably reflect accessibility improvements or regressions. |
|
|
||
| (You can skip the `--key` option by setting `CYPRESS_RECORD_KEY` as an environment variable. Learn more about recording in our [Recorded Runs documentation](/cloud/features/recorded-runs)). | ||
|
|
||
| ## Key benefits |
There was a problem hiding this comment.
Since we have removed the mention of other workarounds, the benefits list doesn't really have a reference point. It still makes sense to mention the existence of workarounds that don't require the Cloud I think.
There was a problem hiding this comment.
Pointed out a few things here and there. Overall this is a big improvement in readability and scanning, I'm surprised how much actually, the before and after is really a different experience. Marking "request changes" specifically as there is chunk in the "About Axe Core®" section that cuts off unexpectedly.
| <a href="/accessibility/guides/improve-accessibility"> | ||
| <Icon name="chart-line" /> | ||
| <h3>Improve Accessibility</h3> |
There was a problem hiding this comment.
If we want to keep this structure, we can shorten the name of the link by referencing the card titles as the label. This way of labelling means there's just one source of truth for the proper name of the card & not two things to update if we re-order the content or whatever.
| <a href="/accessibility/guides/improve-accessibility"> | |
| <Icon name="chart-line" /> | |
| <h3>Improve Accessibility</h3> | |
| <a href="/accessibility/guides/improve-accessibility" aria-labelledby="card-title-1"> | |
| <Icon name="chart-line" /> | |
| <h3 id="card-title-1">Improve Accessibility</h3> |
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
Co-authored-by: Mark Noonan <[email protected]>
I rewrote a good bit of the a11y documentation, working on improving conciseness, scannability and adding more visuals. I also added a 'top guides' section to the a11y intro.
Something like below to highlight Top Guides on the main intro page.